Readme

Lotus Script Doc (LSDoc) is a tool to generate documentation for Lotus Script Libraries. Similar to the JavaDoc tool in the Java Development Kit (JDK), LSDoc parses source code and extracts comments which are written in a special format.

LSDoc is based on XML as data format. This means that the LotusScript source code is parsed and an object model of the library is generated. For example, there are objects for the functions and classes in the libraries. The object model is saved into an XML file describing all important details of the objects. This XML file can be used to generate different documentation.

Because XML is a data format and not very nice to read it is important to have the documentation in a more readable form. Therefore, the XSL parser Xalan (http://www.apache.org) formerly kown as LotusXSL is used to transform the XML files into HTML. As a standard LSDoc has a set of XSL-files which do the translation. Adoptions of these files can be made to personalize the HTML documentation. To change the XSL-file at least basic knowledge of the syntax of the XSL namespace is necessary.

LSDoc is written in pure Java.

Installing LSDoc on Win32:

To install LSDoc open the file LSDoc.zip with the tool Winzip which can be downloaded as shareware form http://www.winzip.com Select the option extract and select a directory in which the tool should be installed. Enable the option “Use foldeer names” (see picture 1) and extract all files.

Winzip Screenshoot


For example if the folder C:\tools is selected for extraction than all files are installed in the directory c:\tools\LSDoc.
After the extraction move to the LSDoc folder and start the file lsdoc.bat. This will start the front-end application of LSDoc.

LSDoc Screenshoot

Known bugs